Skip to content

AUTOSCALE-584: add AGENTS.md and CodeRabbit config#6

Open
maxcao13 wants to merge 1 commit into
openshift:mainfrom
maxcao13:coderabbit
Open

AUTOSCALE-584: add AGENTS.md and CodeRabbit config#6
maxcao13 wants to merge 1 commit into
openshift:mainfrom
maxcao13:coderabbit

Conversation

@maxcao13
Copy link
Copy Markdown
Member

@maxcao13 maxcao13 commented May 5, 2026 •
edited
Loading

AGENTS.md defines design principles (multi-cloud boundaries, CVO manifest rules, operator/operand separation), coding conventions, and the planned architecture direction.

.coderabbit.yaml configures automated PR reviews with AGENTS.md as the knowledge base source, vendor exclusion, and golangci-lint.

Also adds a CLAUDE.md which points to AGENTS.md and a simple README.md.

@openshift-ci-robot
Copy link
Copy Markdown

openshift-ci-robot commented May 5, 2026 •
edited by openshift-ci Bot
Loading

@maxcao13: This pull request references AUTOSCALE-584 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

AGENTS.md defines design principles (multi-cloud boundaries, CVO manifest rules, operator/operand separation), coding conventions, and the planned architecture direction.

.coderabbit.yaml configures automated PR reviews with AGENTS.md as the knowledge base source, vendor exclusion, and golangci-lint.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 5, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 5, 2026
@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 5, 2026
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 5, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maxcao13

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 5, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 3b373061-fc65-4844-8a8c-d71363fd8cc3

📥 Commits

Reviewing files that changed from the base of the PR and between 863eaba and af8a3a6.

📒 Files selected for processing (4)
  • .coderabbit.yaml
  • AGENTS.md
  • CLAUDE.md
  • README.md
✅ Files skipped from review due to trivial changes (2)
  • README.md
  • AGENTS.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • .coderabbit.yaml
  • CLAUDE.md
📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Added comprehensive agent instructions and repository guidelines covering multi-cloud design rules, operator/operand separation, development workflow, and coding conventions
    • Expanded project overview with building, testing, deployment, and developer workflow guidance; linked agent guidance

  • Chores

    • Configured repository automation and review behavior (default language, inheritance, review profile, summaries, walkthroughs, path filters) and enabled golangci-lint
    • Added a local knowledge base to enforce repository coding guidelines and verification steps

Walkthrough

Adds repository scaffolding: CodeRabbit review config, contributor agent guidelines, and project docs. Introduces .coderabbit.yaml, AGENTS.md, README.md, and updates CLAUDE.md to reference AGENTS.md.

Changes

Repository Setup and Guidelines

Layer / File(s) Summary
Review configuration
.coderabbit.yaml		 New CI/review config: sets language en-US, "chill" profile; enables auto-review with draft support and path filter excluding !vendor/**; disables request_changes_workflow, sequence diagrams, effort estimation, poem output, and suggested labels; enables high-level summaries, walkthrough collapse, changed-files summary, and golangci-lint tooling; configures knowledge_base pointing to AGENTS.md, .claude/agents/*.md, and .cursor/rules/*.mdc with local learnings.
Agent guidelines
AGENTS.md		 Adds contributor agent instructions: repo purpose (CVO-managed OpenShift operator for Karpenter), repo layout expectations, multi-cloud constraints (no cloud-provider SDKs in generic packages; detect provider via Infrastructure.status.platformStatus.type; provider-specific logic extensible), operator vs operand separation, vendoring (make vendor), lint/import rules (.golangci.yml), make verify requirement, and comment guidance.
Project documentation
README.md, CLAUDE.md		 README.md adds project overview, build/test/lint/verify/docker-build Make targets, dev deploy instructions (make deploy with IMG, OPERAND_IMG, CLUSTER_NAME, DEV), and links to AGENTS.md. CLAUDE.md updated to reference/alias AGENTS.md.
🚥 Pre-merge checks | ✅ 11 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Topology-Aware Scheduling Compatibility ⚠️ Warning Deployment manifest (install/05_deployment.yaml) uses nodeSelector targeting control-plane nodes, which breaks on HyperShift where no control-plane nodes exist in-cluster. Add topology-awareness checks. Detect HyperShift via infrastructure.Status.ControlPlaneTopology and avoid nodeSelector for control-plane on External topology. Test with HyperShift CI before merging.
✅ Passed checks (11 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: adding AGENTS.md and CodeRabbit configuration, which are the primary additions in this PR.
Description check ✅ Passed The description is directly related to the changeset, clearly explaining the purpose of AGENTS.md, .coderabbit.yaml, CLAUDE.md, and README.md additions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed PR does not introduce Ginkgo tests. The check is not applicable - only config and documentation files are added. No dynamic test names found.
Test Structure And Quality ✅ Passed The PR's single test file (pkg/operator/options_test.go) uses standard Go testing package, not Ginkgo. The custom check is specific to Ginkgo test code, making it not applicable to this PR.
Microshift Test Compatibility ✅ Passed No Ginkgo e2e tests are added in this PR. PR adds only configuration files (.coderabbit.yaml) and documentation (AGENTS.md, CLAUDE.md, README.md). Check is not applicable.
Single Node Openshift (Sno) Test Compatibility ✅ Passed PR does not add any Ginkgo e2e tests. Only documentation and configuration files (AGENTS.md, README.md, CLAUDE.md, .coderabbit.yaml) are added. SNO compatibility check is not applicable.
Ote Binary Stdout Contract ✅ Passed Code uses controller-runtime's zap wrapper which defaults to os.Stderr. No direct stdout writes in process-level code. Logging properly configured via ctrl.SetLogger().
Ipv6 And Disconnected Network Test Compatibility ✅ Passed No Ginkgo e2e tests present. PR adds documentation, config files, and standard Go unit tests only.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

Comment @coderabbitai help to get the list of available commands and usage tips.

@maxcao13 maxcao13 marked this pull request as ready for review May 7, 2026 19:40
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 7, 2026
@openshift-ci openshift-ci Bot requested review from elmiko and joelsmith May 7, 2026 19:40
@maxcao13 @cursoragent
docs: add AGENTS.md, CodeRabbit config, README
af8a3a6 
AGENTS.md defines design principles (multi-cloud boundaries, CVO
manifest rules, operator/operand separation), coding conventions,
and the planned architecture direction.

.coderabbit.yaml configures automated PR reviews with AGENTS.md
as the knowledge base source, vendor exclusion, and golangci-lint.

Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Max Cao <macao@redhat.com>
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 11, 2026

@maxcao13: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@elmiko elmiko Awaiting requested review from elmiko

@joelsmith joelsmith Awaiting requested review from joelsmith

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@maxcao13 @openshift-ci-robot